/*
 * gybon - Core modules for Google Yahoo Rich Application Framework
 *
 * Copyright (c) 2009, Yves Cuillerdier
 * All rights reserved.
 * 
 * This software is licensed under the new BSD License:
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, 
 * this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution.
 * 
 * Neither the name of the author nor the names of its contributors may 
 * be used to endorse or promote products derived from this software without 
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * @version 0.2.0
 */
package gyraf.wrapper.client.logger;

import com.google.gwt.core.client.JavaScriptObject;
import com.google.gwt.user.client.Element;

/**
 * A YUI LogReader wrapper.
 * <p>
 * The LogReader class provides UI to read messages logged to
 * YAHOO.widget.Logger.
 */
public final class YuiLogReader {

	/**
	 * Mandatory constructor
	 */
	protected YuiLogReader() {
		// Mandatory constructor for JavaScriptObjects
	}

	/**
	 * Factory to Instantiate a default floating log reader.
	 */
	public static native YuiLogReader instanciate() /*-{
		var log = new $wnd.YAHOO.widget.LogReader();
		return log;
	}-*/;

	/**
	 * Factory to Instantiate a floating log reader.
	 * 
	 * @param attrs
	 *            A key map of the tab's initial attributes.
	 */
	public static native YuiLogReader instanciate(JavaScriptObject attrs) /*-{
		var title = attrs.title; // 
		var log = new $wnd.YAHOO.widget.LogReader(attrs);
		if (title) {
			log.setTitle(title);
		}
		return log;
	}-*/;

	/**
	 * @return the LogReader's DOM element
	 */
	public native Element getElement() /*-{
		return this._elContainer; // private!! Must we?
	}-*/;

	// ////////////////////////////////////////////////////////////////////////
	// Methods
	// //////////////////////////////////////////////////////////////////////

	/**
	 * Pauses output of log messages. While paused, log messages are not lost,
	 * but get saved to a buffer and then output upon resume of LogReader.
	 */
	public native void pause() /*-{
		this.pause();
	}-*/;

	/**
	 * Resumes output of log messages, including outputting any log messages
	 * that have been saved to buffer while paused.
	 */
	public native void resume() /*-{
		this.resume();
	}-*/;

	/**
	 * Hides UI of LogReader. Logging functionality is not disrupted.
	 */
	public native void hide() /*-{
		this.hide();
	}-*/;
	
	/**
	 * Shows UI of LogReader. Logging functionality is not disrupted.
	 */
	public native void show() /*-{
		this.show();
	}-*/;
	
	/**
	 * Collapses UI of LogReader. Logging functionality is not disrupted.
	 */
	public native void collapse() /*-{
		this.collapse();
	}-*/;
	
	/**
	 * Expands UI of LogReader. Logging functionality is not disrupted.
	 */
	public native void expand() /*-{
		this.expand();
	}-*/;
	
	/**
	 * 
	 */
	public native void clear() /*-{
		this.reset();
	}-*/;
	
	
}
